IMotion.SetAxisVelocity method

Sets the target velocity of an axis. This method can be used only in the Direct Velocity control mode, in which this is the only method to set the target velocity of an axis.

Namespace: IntervalZero.KINGSTAR.Base.Api

Assembly: IntervalZero.KINGSTAR.Base.Api (in IntervalZero.KINGSTAR.Base.dll) Version: 4.4.0.0

Syntax

C#VB

KsError SetAxisVelocity(
       int Index,
       double Velocity
)

Function SetAxisVelocity(
       Index As Integer,
       Velocity As Double
) As KsError

Parameters

Index

Type: int

The index of an axis. Indexes are zero based. Aliases affect this parameter.

Velocity

Type: double

The velocity of an axis in user unit per second.

Return value

Type: KsError

A return code of a method.

Remarks

Using the Direct Velocity mode you can set the axis' velocity every cycle based on your needs or customized interpolation.

Examples

N/A